Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Create a Custom Property Definition

cURL

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/{entity_type}/custom_properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "property_name": "sector",
  "property_type": "text"
}
'

400

[
  {
    "title": "400 Bad Request",
    "description": "The request body was not structured correctly."
  }
]

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

entity_type · string · required

Custom Properties are supported on the following entity types: taxonomy/domains, taxonomy/subdomains, taxonomy/skill_clusters, taxonomy/skills, employees, organisational_units, job_architecture/job_families, job_architecture/jobs, vacancies, courses, skill_clusters, and companies.

Body

application/json

Default structure for CustomPropertyDefinition.

property_name · string · required

The name of the Custom Property. Can not contain __.

Required string length: 1 - 100

Example:

"sector"

property_type · enum<string> · required

Expected type of the Custom Property.

Available options: text, number, boolean, list[text], datetime

Required string length: 1 - 10

Example:

"text"

Response

204

No Content